Шаблон:Приклад
Документація шаблону | Цей шаблон використовує Lua: |
Шаблон призначений для спрощення оформлення прикладів використання шаблонів у документаціях. Він видає вікі-текст виклику шаблону (в загальному випадку з параметрами) і результат цього виклику.
В цей момент шаблон не може використовуватися для оформлення прикладів шаблонів з багаторядковим кодом і які містять шаблони усередині шаблону. (Хоча це технічно реалізовується)
Для виведення груп прикладів користуйтеся шаблонами Шаблон:T (списком) і Шаблон:T (таблицею).
Використання
{{приклад|t|t}}дає{{t|t}}→{{приклад|replace|something|some|any}}дає{{replace|something|some|any}}→ anything{{приклад|tlc|шаблон|параметр 1|||параметр 4}}дає{{tlc|шаблон|параметр 1|||параметр 4}}→{{шаблон|параметр 1|||параметр 4}}{{приклад|tlu|:en:Template:Example|alt=English Template:Example}}дає{{tlu|:en:Template:Example|alt=English Template:Example}}→
Перший параметр можна опускати — тоді його замінить назва поточної сторінки з малої першої літери. Наприклад, в документації шаблону Шаблон:T {{приклад||слово}} дає:
{{tr-en|слово}}→
Це може бути особливо зручним для груп шаблонів, для яких пишеться загальна документація, що розміщується на кожній сторінці. А {{приклад}} виведе приклад виклику шаблону, на сторінці якого цей код розміщений, без параметрів.
Для наочності можна також вказувати назву шаблону через параметр_template, при цьому перший параметр більше не означає назву шаблону:
{{приклад|_template=t|приклад}}дає{{t|приклад}}→
Обмеження та шляхи їх обходу
Модуль переносить всі іменовані параметри в кінець, а також погано зберігає порядок проходження іменованих параметрів, якщо їх більше одного (через технічну недосконалість програмного забезпечення). Щоб цього уникнути, слід використовувати {{=}} замість =:
 |
{{приклад|якийсь шаблон|parameter1=value|parameter2=value|parameter3=value}} дає:{{якийсь шаблон|parameter1=value|parameter3=value|parameter2=value}} →
|
 |
{{приклад|якийсь шаблон|parameter1{{=}}value|parameter2{{=}}value|parameter3{{=}}value}} дає:{{якийсь шаблон|parameter1=value|parameter2=value|parameter3=value}} →
|
Також не можна записувати безпосередньо параметри, чиї назви починаються зі знака підкреслення, — для запобігання перетину з параметрами, що модифікують зовнішній вигляд результату. Допоможе те саме рішення:
{{приклад|tp|шаблон|_text{{=}}текст посилання}}дає{{tp|шаблон|_text=текст посилання}}→
Аби вписати Шаблон:Tago, використовуйте HTML-сутності для заміни кутових дужок, наприклад:
{{приклад|tp|шаблон|<nowiki><nowiki>{{IPA|/tʃ/}}</nowiki></nowiki>}}дає{{tp|шаблон|<nowiki>{{IPA|/tʃ/}}</nowiki>}}→
Аби вписати {{=}}, використовуйте {{((}}{{=}}{{))}} або HTML-сутності, наприклад:
{{приклад|pre|текст {{((}}{{=}}{{))}} текст|_sep={{sp↓|||-0.5em}}}}дає
{{pre|текст [[:Шаблон:((]]=[[:Шаблон:))]] текст}}Шаблон:Sp↓
НаразіШаблон:Коли не підтримується розкриття вкладених шаблонів та інших конструкцій з фігурними дужками (їх можна вказувати всередині Шаблон:Tago, але вони не розкриються). Багаторядкові шаблони також не підтримуються.
Налаштування
_sep: поміняти стрілочку на що завгодно інше:
{{приклад|t|t|_sep=відображається як}}дає{{t|t}}відображається як
_tag: поміняти обгортку <code> (а за допомогою _container зробити так, щоб код прикладу оброблявся шаблоном-контейнером, наприклад Шаблон:T):
{{приклад|_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. При цьому в коді виклику шаблону цей параметр відображатися не буде. Так, наприклад, в цьому прикладі справжня сторінка не додається до категорії Шаблон:Cl:
{{приклад|NASDAQ|123|_nocat=1}}дає{{NASDAQ|123}}→
_spaced: відбити пробілом кожен параметр для кращого читання:
{{приклад|MathWorld|urlname=GammaFunction|title=Gamma Function|author=John Doe|_spaced=1}}дає:{{MathWorld |author=John Doe |urlname=GammaFunction |title=Gamma Function}}→
Стилі
За допомогою параметра _style можна встановити стиль, який буде встановлювати деякі з перерахованих вище параметрів разом. Існуючі наразі стилі — pre, *pre і wikitable (а також pre↓):
{{приклад|нейтральність|_style=pre}}дає:
{{приклад|нейтральність|_style=*pre}}дає:
- дає
-
Код Результат {{Атлас світу|1967}} {{Атлас світу|1991}} …