Шаблон:Msgnw — Мегавики

Документация

[просмотр | править | история | обновить]

Этот шаблон реализован на основе Lua с использованием функции withParams() из модуля Template call code.

См. Рувики:Механизм шаблонов#msgnw.

Документировать карон понна шаблонъёс

Шаблонъёс

простая ссылка без ссылки subst: подст: любое ПИ другой текст другой раздел для навигации

обычный {{tl}} (без параметров)
{{tlp}} (с параметрами) - {{subst:tls}} {{подст:шсп}} {{tlu}} {{tla}} {{flt}}
{{ent}} (для англовики) {{tnav}}

<code> {{tcl}} {{tc}} {{subst:tcls}} - - - - -

<pre>

Этот шаблон реализован на основе Lua с использованием функции withParams() из модуля Template call code.

{{msgnw}} совмещает в себе функцию {{tc}} и {{pre}}. С его помощью удобно создавать примеры использования шаблонов в их документациях.

Например, чтобы показать синтаксис шаблона {{перенесено с}}, мы можем в его документации написать так:

{{tpre||''Вики-страница''{{optp|''подпись и/или текст в конце''|текст{{=}}''Текст вместо «Перенесено со страницы»''}}}}
{{optp/comment}}

и получим:

Шаблон:Tpre шаблонэн сузьет шедьтэмын

Серым показаны необязательные параметры.

Про такой стиль оформления синтаксисов шаблонов в документациях см. | вместо использования специального параметра -->

Шаблон:Tc § В оформлении документации

Шаблон:Tc#В оформлении документации

}}.

Между тем в многострочных примерах этот шаблон лучше не использовать по причине съедания пробелов до вертикальных черт, прибегая вместо него к оформлению при помощи пробела в начале строк. Это тоже позволяет включать разметку в код. Например (в начале каждой строки — пробел):

 {{((}}main
  |''Статья 1''
  |''Статья 2''
  |l1=''Отображаемый текст ссылки 1''
  |l2=''Отображаемый текст ссылки 2''
 }}

который даст:

{{main

Статья 1

Статья 2

l1=Отображаемый текст ссылки 1

l2=Отображаемый текст ссылки 2

}}

Настройки

Если задать |_spaced=1, параметры шаблона будут отбиты пробелами:

{{msgnw|ш|параметр 1{{=}}значение|параметр 2{{=}}значение|_spaced=1}}

↓

См. также

{{*tpre}} — то же самое с маркером списка (иначе его нельзя использовать напрямую)
{{sp↓}} — отбитая от левого края стрелка вниз, чтобы оформить ею результат обработки того, что показано в шаблоне {{tpre}}
{{пример}} — код вызова шаблона → результат; см. там стиль pre
{{pre}}
{{между pre}}

Шаблон:Шаблоны для документирования шаблонэн сузьет шедьтэмын

{{mwmw|PAGENAME}} → {{PAGENAME}}
{{msgnw|пример}} → {{msgnw:пример}}
{{ub|Таблица}} → {{User:Box~udmwiki/Таблица}}

Параметръёс

{{para|пример}} → |пример=

{{optp|пример1|пример2}} →

Этот шаблон реализован на основе Lua с использованием функции onlyParams() из модуля Template call code.

Шаблон для выделения необязательных параметров в коде вызова шаблона серым (optp — optional parameters).

Этот шаблон реализован на основе Lua с использованием функции withParams() из модуля Template call code.

Например, чтобы показать синтаксис шаблона {{перенесено с}}, мы можем в его документации написать так:

{{tpre||''Вики-страница''{{optp|''подпись и/или текст в конце''|текст{{=}}''Текст вместо «Перенесено со страницы»''}}}}
{{optp/comment}}

и получим:

Шаблон:Tpre шаблонэн сузьет шедьтэмын

Серым показаны необязательные параметры.

Про такой стиль оформления синтаксисов шаблонов в документациях см. | вместо использования специального параметра --> | Шаблон:Tc § В оформлении документации | Шаблон:Tc#В оформлении документации }}.

 {{((}}main
  |''Статья 1''
  |''Статья 2''
  |l1=''Отображаемый текст ссылки 1''
  |l2=''Отображаемый текст ссылки 2''
 }}

который даст:

{{main
 |Статья 1
 |Статья 2
 |l1=Отображаемый текст ссылки 1
 |l2=Отображаемый текст ссылки 2
}}

Настройки

Если задать |_spaced=1, параметры шаблона будут отбиты пробелами:

Шаблон:Пример шаблонэн сузьет шедьтэмын

См. также

{{*tpre}} — то же самое с маркером списка (иначе его нельзя использовать напрямую)
{{sp↓}} — отбитая от левого края стрелка вниз, чтобы оформить ею результат обработки того, что показано в шаблоне {{tpre}}
{{пример}} — код вызова шаблона → результат; см. там стиль pre
{{pre}}
{{между pre}}

Шаблон:Шаблоны для документирования шаблонэн сузьет шедьтэмын

↓

{{переход|#Раздел или #якорьШаблон:Optp шаблонэн сузьет шедьтэмын}}

Серым показаны необязательные параметры.

Про такой стиль оформления синтаксиса шаблона в документациях см. Шаблон:Tc#В оформлении документации.

Детали

По адресу {{optp/comment}} находится строка:
Серым показаны необязательные параметры.
Её можно давать под синтаксисом.
Чтобы в списке параметров под синтаксисом использовать серый цвет для указания, что параметр является необязательным, используйте класс ts-templateCallCode-weak, например: <code class="ts-templateCallCode-weak">''тип значка''</code> → тип значка

Шаблон:Шаблоны для документирования шаблонэн сузьет шедьтэмын

{{param|пример}} → {{{пример}}}
{{tpa|пример}} → {{{пример}}}

Тегъёс

{{tag|пример}} → <пример></пример>
{{tagr|пример}} → <пример></пример>
{{tago|пример}} → <пример>
{{tagor|пример}} → <пример>
{{tagc|пример}} → </пример>
{{xtag|nowiki}} → <nowiki>

Примеръёс

{{пример}}
- {{стопка примеров}}
- {{таблица примеров}}
{{demo}} (может показывать результат обработки любого вики-текста)
{{строка таблицы примеров}}
{{пример с именами параметров}}
{{заготовка шаблона}}
{{пример шаблона}}
{{markup}}
{{markup2}}
{{markupv}}

Шаблонъёсты документировать каронъя дэмланъёс
Категории: Шаблоны:Для документирования шаблонов; Шаблоны:Ссылки на шаблоны