Модуль:Tl/doc

Материал из Справочника наблюдателя
Перейти к:навигация, поиск

Это страница документации Модуль:Tl


Функции tl / tlf / lg[]

Модуль {{ tl}}  предназначен для создания ссылок на шаблоны (а также модули, системные сообщения и, в принципе, на любые страницы). Рассчитан преимущественно для использования в шаблонах (например, {{tl}}  и {{tlf}} )).

В модуле определены функции {{#invoke:tl|tl}}, {{#invoke:tl|tlf}}, сопоставляемые одноименным шаблонам, а также универсальная функция {{#invoke:tl|lg}}, которая позволяет настраивать все параметры шаблона. Все функции рассчитаны на вызов из специального шаблона и под параметрами функции далее понимаются параметры вызывающего шаблона.

Первым параметром всех указанных функций является имя шаблона, на который осуществляется ссылка, далее задаются параметры этого шаблона. Различие в функциях состоит исключительно в значениях параметров по умолчанию, любое из них может быть изменено явным заданием. Эти параметры задаются следующим образом:

параметр назначение параметра умолчание
lg tl tlf
#code= ссылка обертывается в теги <code>...</code> no no yes
#icon= вместо имен пространств Module, MediaWiki, HTML отображаются соответствующие иконки no yes no
#edit= после ссылки отображается иконка для перехода к редактированию шаблона no yes no
#talk= после ссылки отображается иконка для перехода к странице обсуждения no no no
#output= вместе со ссылкой отображается результат исполнения соответствующего шаблона. Возможные значения:
  • произвольный текст — результатом работы шаблона является указанный текст, в котором $t заменяется на изображение вызова (ссылки на шаблон), а $r — на изображение результата этого вызова;
  • no — показывается только сам вызов
  • yes — эквивалентно $t → <samp>$r</samp>
  • tdtd — эквивалентно <tr><td>$t</td><td><samp>$r</samp></td><tr>
no no no
#wh= из показываемого текста ссылки исключается указание интервики no no no
#compact= вместо красивой ссылки показывается текст, указанный в этом параметре no no no

Если шаблон, на который необходимо сослаться, содержит ключевые параметры с именами, начинающимися с символа #, то этот символ следует удвоить.

Demo[]

Функция {{#invoke:tl|Demo}} предназначена для демонстрации вики-текста и результата его действия. Первым параметром функции (точнее, вызывающего функцию шаблона) должен являться вики-текст заключенный в теги <nowiki>...</nowiki>. Другим параметром может являться |#output=, описанный выше.