თარგი:Example/ინფო
თენა რე დოკუმენტაციაშ გიმენხასჷლა (თარგი:Example). თინა იკათუანს ოხვილურ ინფორმაციას, კატეგორიეფს, ნინეფიშოშქაშე რცხუეფს დო შხვა მოღეს, ნამუთ რე ორიგინალი თარგიშ ნორთი. თარგი:Example · დოკუმენტაცია · სხუნუა · გჷმორინაფა |
გჷმირინუანს ლუას: |
Шаблон предназначен для упрощения оформления примеров использования шаблонов в документациях. Он выдаёт вики-текст вызова шаблона (в общем случае с параметрами) и результат этого вызова.
Использование
[წყუშ რედაქტირაფა]{{Example|t|t}}
даст{{t|t}}
→{{Example|replace|something|some|any}}
даст{{replace|something|some|any}}
→ anything{{Example|tlc|шаблон|параметр 1|||параметр 4}}
даст{{tlc|шаблон|параметр 1|||параметр 4}}
→{{шаблон|параметр 1|||параметр 4}}
{{Example|tlu|:en:Template:Example|alt=English Template:Example}}
даст{{tlu|:en:Template:Example|alt=English Template:Example}}
→
Первый параметр можно опускать — тогда его заменит название текущей страницы со строчной первой буквы. Например, в документации шаблона თარგი:T {{Example||слово}}
даст:
{{tr-en|слово}}
→
Это может быть особенно удобно для групп шаблонов, для которых пишется общая документация, размещаемая на каждой странице. А {{Example}}
выведет пример вызова шаблона, на странице которого этот код размещён, без параметров.
Для наглядности можно также указывать имя шаблона через параметр _template, при этом первый параметр больше не значит имя шаблона:
{{Example|_template=t|Example}}
даст{{t|Example}}
→
Ограничения и пути их обхода
[წყუშ რედაქტირაფა]Модуль переносит все именованные параметры в конец, а также плохо сохраняет порядок следования именованных параметров, если их больше одного (из-за технического несовершенства ПО). Чтобы этого избежать, следует использовать თარგი:Tcl вместо =
:
15px | {{Example|некий шаблон|parameter1=value|parameter2=value|parameter3=value}} даст:{{некий шаблон|parameter1=value|parameter3=value|parameter2=value}} →
|
15px | {{Example|некий шаблон|parameter1{{=}}value|parameter2{{=}}value|parameter3{{=}}value}} даст:{{некий шаблон|parameter1=value|parameter2=value|parameter3=value}} →
|
Также нельзя записывать напрямую параметры, чьи имена начинаются со знака подчёркивания, — для предотвращения пересечения с параметрами, модифицирующими внешний вид результата. Поможет то же решение:
{{Example|tp|шаблон|_text{{=}}текст ссылки}}
даст{{tp|шаблон|_text=текст ссылки}}
→{{шаблон}}
Чтобы вписать თარგი:Tago, используйте HTML-сущности для замены угловых скобок, например:
{{Example|tp|шаблон|<nowiki><nowiki>{{IPA|/tʃ/}}</nowiki></nowiki>}}
даст{{tp|шаблон|<nowiki>{{IPA|/tʃ/}}</nowiki>}}
→{{шаблон|{{IPA|/tʃ/}}}}
Чтобы вписать {{example}}
, используйте {{((}}{{=}}{{))}}
или HTML-сущности, например:
{{Example|pre|текст {{((}}{{=}}{{))}} текст|_sep={{sp↓||-0.5em}}}}
даст
{{pre|текст [[:თარგი:((]]=[[:თარგი:))]] текст}}
თარგი:Sp↓
В данный момент не поддерживается раскрытие вложенных шаблонов и других конструкций с фигурными скобками (их можно указывать внутри თარგი:Tago, но они не раскроются). Многострочные шаблоны также не поддерживаются.
Настройки
[წყუშ რედაქტირაფა]_sep: поменять стрелочку на что угодно другое:
{{Example|t|t|_sep=отображается как}}
даст{{t|t}}
отображается как
_tag: поменять обёртку <code> (а с помощью _container сделать так, чтобы код примера обрабатывался шаблоном-контейнером, например თარგი:T):
{{Example|_template=t|_tag=tt|სამანგა}}
даст {{t|სამანგა}} →
_link: включить отображение ссылки:
_pre-text (_prefix) и _post-text (_postfix): указать текст до и после шаблона:
{{Example|tr-en|слово|_pre-text=word (|_post-text=)}}
дастword ({{tr-en|слово}})
→ word ()
_nobr: запретить перенос строки для кода примера.
_nocat: запретить добавлять страницу в проставляемые шаблоном категории, если у него предусмотрен соответствующий параметр _nocat
. При этом в коде вызова шаблона этот параметр отабражаться не будет. Так, например, в данном примере настоящая страница не добавляется в категорию კატ.:Компании, имеющие листинг акций на NASDAQ:
{{Example|NASDAQ|123|_nocat=1}}
даст{{NASDAQ|123}}
→
_spaced: отбить пробелом каждый параметр для лучшей читаемости:
{{Example|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}}
даст:
{{Example|проверить нейтральность|_style=*pre}}
даст:
- даст
-
Код Результат {{Атлас мира|1967}} {{Атлас мира|1991}} …
См. также
[წყუშ რედაქტირაფა]