Шаблоны являются специальными статьями, содержимое которых предназначенно для многократного включения в другие статьи. Таким образом, можно добиваться не только ссылочной целостности и актуальности, но и текстовой, т. к. изменения в одной статье-шаблоне автоматически распространятся на все включающие ее статьи. К тому же, шаблоны можно параметризовать, добиваясь унифицированного описания однородных объектов. Далее, мы опишем, как их использовать.
Общая информация
Статьи-шаблоны располагаются в специальном пространстве имен «Template», т. е. они имеют префикс «Template:».
Содержимое каждой такой статьи (вне зависимости, фиксировано ли оно, или зависит от некоторых переменных параметров) предназначено для удобства включения в другие статьи, т. е. для создания составных документов.
Для того, чтобы включить статью «Template:name», нужно использовать следующий синтаксис (так называемый тэг шаблона) {{name}}. Тогда при показе статьи будет подставлено содержимое ссылаемого шаблона. Терминологически, этот процесс можно также называть
- вызовом шаблона;
- ccылкой на шаблон;
- включением шаблона;
- использованием шаблона; — в любом из перечисленных вариантов, речь идет об одном и том же.
Если страница «Template:name» еще не существует, то {{name}} будет работать как [[Template:name]], т. е. как ссылка на несуществующую статью, которую можно редактировать. Таким образом, шаблоны также удобно заводить, сначала сделав на него ссылку, а затем проследовав по ней.
Если статья name уже существует в обычном (не шаблонном) пространстве имен, или начинается с двоеточия (что означает ссылку на основное пространство имен), то ссылка не будет автоматически направлятся в шаблонное пространство имен «Template:». Таким образом, любую страницу можно использовать как шаблон. (Примечание: если вызывать так картинку или категорию — то будет подставлена описательная часть картинки и категории соответственно).
Таким образом удобно
- экспериментировать с шаблонами (не залезая в пространство шаблонов);
- «вытаскивать» подписи и описания картинок;
- изготавливать специальные составные статьи (например для печати).
Напоминаем, что как обычно, имя статьи или шаблона чувствительно к регистру, и что пробел эквивалентен подчеркиванию.
Возможно также рекурсивное включение.
Переменные шаблона вычисляются после вставки шаблона в «вызывающую» статью, т. е. если в шаблоне содержится подстановка {{PAGENAME}}, то она будет развернута в имя вызывающей статьи, а не имя шаблона.
Список ссылок на использованные на странице шаблоны показывается на странице редактирования статьи, причем показываются все шаблоны, даже если редактируется только раздел документа, который не содержит шаблонов.
Параметры
Параметры шаблона могут быть поименованные или пронумерованные.
Синтаксис использования может быть
- {{templatename|parname1=parvalue1|parname2=parvalue2}}, тогда в теле шаблона надо ссылаться на {{{parname}}};
- {{templatename|parvalue1|parvalue2}} тогда в теле шаблона нужно использовать {{{1}}}, {{{2}}}.
Лишние (не используемые в теле шаблона) параметры игнорируются.
Имена параметров чувствительны к регистру, пробелы, подчеркивание и остальные символы не из набора [a-z\-A-Z0-9] недопустимы.
- Обратите внимание на тройные фигурные скобки при использовании параметров!
Т.е. механизм шаблонов выполняет два типа подстановок:
- вызов шаблона (двойные фигурные скобки) заменяется содержимым шаблона;
- параметры шаблона (тройные фигурные скобки) заменяются параметрами шаблона.
Параметром шаблона может быть ссылка на другую статью. Пусть например у нас есть Шаблон:
Начало {{{1}}} Конец.
Тогда
{{Шаблон| [[Main_Page|Главная страница]]}}
будет развернуто в
Начало Главная страница Конец.
Если какой-то параметр «someparameter» не задан, то он остается нераскрытым текстом {{{someparameter}}}, что позволит раскрыть его, если вызвавшая шаблон статья, также включается куда-то, где этот параметр задан.
- Заметим, что вызов {{Шаблон||a}} делает первый параметр определенным, но равным пустой строке. Если нужно задать второй параметр, не определяя первый, то нужно использовать вызов {{Шаблон||2=a}}. Этот синтаксис нужно использовать также, когда параметр вызова содержит знак "=", например "a=b", т.е. {{Шаблон|a=b|c}}, не определит параметр "1", зато определит параметр "a", зато {{Шаблон|1=a=b|2=c}} сделает все как надо.
Просмотр содержимого шаблона
Чтобы правильно увидеть содержимое шаблона, нужно смотреть на шаблон в режиме редактирования, т. к. некоторые подстановки, типа {{PAGENAME}}, могут раскрыться.
msgnw
Для показа содержимого шаблона (без wiki-интерпретации) можно использовать кодовый «волшебный» префикс u «msgnw:». Т.е. {{en}} и {{msgnw:en}} будут показаны как Шаблон:En и [[:Шаблон:En]] соответственно.
Ссылка на редактирование шаблона
«Редактирующая» ссылка на каждой странице-статье не позволяет редактировать текст используемого шаблона, а иногда желательно иметь такую ссылку (приглашающую поправить шаблон, например, если шаблон еще не устоялся, или если его содержимое может часто изменяться). Такую ссылку можно «зашить» внутрь самого шаблона, даже более того, сделать шаблоном, который можно использовать внутри других шаблонов.
См. template:edit.
Ограничения и возможности
Использование вложенных двойных или тройных фигурных скобок внутри двойных вложенных скобок
Не получиться вызывать шаблоны в зависимости от содержимого других шаблонов.
Допустим, у нас есть шаблон «tctc» с содержимым «tc», и шаблон «tc» с содержимым «Ура».
Тогда вызов {{{{tctc}}}} даст текст {{{{tctc}}}}, а не «Ура».
Не получится использовать значение раскрытого шаблона при вызове другого шаблона.
Зато можно использовать значения переданных переменных, при указании значений переменных для вызываемого шаблона.
Тэг категории в шаблоне. Проблема с кэшированием
Если шаблон содержит код категории, то в указанную категорию помещается не только шаблон, но и все страницы, включающие его, поэтому удобно использовать шаблоны для рубрикации статей.
Но может возникнуть проблема с кэшированием — если поменять категорию у шаблона, то категория у включающих него страниц поменяется только после выполнения каких-либо правок этих страниц (не обязательно при этом что-либо менять, т.е. операция правка может быть чисто формальной).
Кэширование
Правка шаблона автоматически сбрасывает кэширование всех статей, напрямую использующих этот шаблон. Однако в случае с косвенными зависимостями (шаблоны зависящие от параметров и т. п.), внутренний кэш системы не сбрасывается и стандартный «Refresh» броузера может не помочь.
В таких случаях используйте «action=purge», т. е. вызывайте URL типа
http://lib.custis.ru/index.php?title=CustisWiki&action=purge
subst
Используя «subst:» после двойных фигурных скобок заставляет выполнять подстановку
текста шаблона или даже переменной в момент сохранения ссылающейся страницы.
Например «timestamp»:
{{subst:CURRENTDAY}} {{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}, {{subst:CURRENTTIME}} (UTC)
подставится при сохранении, как:
3 March 2005, 16:56 (UTC)
Альтернатива subst
- Используйте {{..}}, затем, в окне «preview», вытащите результат и замените исходные {{..}}.
- Аналогично можно использовать msgnw.
Перенаправления
Когда страница, вызванная для включения, является страницей-перенаправлением, то включается содержимое страницы, на которую указывает перенаправление.
Страница, которая ничего не содержит, кроме включения другой страницы, в общем схожа со страницей-перенаправлением, но имеет и множество различий, например:
- Заголовок страницы-результата есть имя исходной страницы, а не включаемой страницы.
- Вся функциональность, (редактирование, обсуждение, watch-list, …) относится к включающей странице, и ничего (если не смотреть код) не связывает ее с включаемой страницей.
- Включающая страница лежит в тех же категориях, что и включаемая.
- Работают «двойные перенаправления» основанные на включении.
Ссылки на шаблон
Отметим, что если ссылаться (в смысле гиперссылок) на шаблоны, как на обычные статьи, то нельзя передать им параметры (что, в общем, очевидно). Однако, иногда это может быть полезно, например, ссылка на увеличенное изображение.
История изменений для страниц содержащих шаблоны
При просмотре исторических версий статей, содержащих шаблоны и/или картинки, всегда используется текущая версия шаблонов (и картинок), т. е. невозможна автоматическая «абсолютная» реконструкция исторических версий композитных текстов, чтобы также содержались ссылки на соответствующие картинки и шаблоны.
Функции парсера
В CustisWiki установлено расширение ParserFunctions, позволяющее выполнить нетривиальное препроцессирование разметки.
Более подробно см. RuPedia:Википедия:Функции парсера.
Ссылки
== включается только когда шаблон не включен в статью. Наоборот, includeonly работает только когда шаблон включен в другую статью. Применение - категории, распространяющиеся только на шаблон или только на его включение; оглавление и титульный лист, которые должно уйти при включении во композитную статью и т.п.
Статья реплицируется в SMWiki, SBWiki, RDWiki, GZWiki, DPWiki, HRWiki, CBWiki, ORWiki, RAWiki, ITWiki, CRMWiki, NordeaWiki, EvolWiki.
