Википедия:Подстановка шаблонов
Подст — сокращение от «подставить» (subst аналогично от слова «substitution»). Эта инструкция вики-синтаксиса используется как префикс названия специального типа шаблонов — подстановочных шаблонов. Например, так: {{подст:имя_шаблона}}. В отличие от обычных шаблонов, подстановочные шаблоны предназначены для непосредственной вставки их содержимого в текст статьи. Таким образом, сразу после сохранения страницы, её содержимое меняется.
Обычный шаблон раскрывается «на лету», это значит, что при обращении к странице, на которой установлен шаблон, сервер запрашивает содержимое шаблона и размещает его на странице при каждом просмотре. Если в шаблоне происходят какие-то изменения, то эти изменения коснутся всех страниц, в которые он уже вставлен.
Подстановочный шаблон заменяет своё название с префиксом на своё содержимое, и поэтому последующие изменения в подстановочном шаблоне никак не отразятся на внешнем виде и на содержимом всех страниц, в которых применялся данный подстановочный шаблон в прошлом.
Содержание
Использование
Для того чтобы раскрыть шаблон на странице, следует добавить в него префикс «подст» («subst»). Например, {{пример}} и {{подст:пример}} ({{subst:пример}}).
Во втором случае содержимое шаблона {{пример}} заменит собой этот код.
Делая подобную подстановку, желательно, чтобы в описании правки Вы указали, какой шаблон вы ставите, чтобы другим пользователям было проще ориентироваться в ситуации. Так же, создавая или редактируя шаблон, который обычно требует раскрытия с помощью префикса «подст», желательно добавить HTML-комментарий на страницу шаблона. Это поможет другим участникам понять, как шаблон должен быть использован.
Преимущества подстановки
- Шаблоны часто модифицируются или даже удаляются. Если шаблон представляет собой текст, который в дальнейшем не будет меняться, то следует использовать подстановку. В качестве примера можно привести шаблон {{welcome}}. Архивы страниц обсуждения участников должны содержать сообщение-приветствие, которое участники получили, а не текущее содержимое шаблона.
- Если существует шаблон, который нужно модифицировать для единичного случая, не затрагивая при этом остальные страницы, где данный шаблон используется, а создавать новый шаблон смысла нету, то можно раскрыть нужный шаблон, а затем на той странице, где была произведена подстановка, подкорректировать код по своему усмотрению.
- Подстановка часто используемых, но не защищенных от редактирования шаблонов (которых мало — почти все часто используемые шаблоны защищены от редактирования) помогает ограничить ущерб, который может быть причинен вандализацией таких шаблонов. (см. Критические шаблоны).
- Раскрытие шаблонов позволяет новичкам просматривать викитекст, который содержится в шаблоне, что помогает быстрее освоить викиразметку.
- Подстановка в целом может ускорить работу сайта, хотя это и является поводом для постоянных споров и дискуссий. Каждый раз, когда страница изменяется, сервер запрашивает текст с других страниц для каждого шаблона, который помещен на редактируемой странице. Эффект одного отдельно взятого шаблона невелик, но в сумме они создают значительную нагрузку на сервер, что значительно влияет на время загрузки страниц. Однако, Brion Vibber, технический директор проекта (ответственный за техническую сторону работы Фонда Викимедия) заявил:
«Правила» не должны заботиться о нагрузке на сервер, за исключением особых случаев; создание условий для решения основных нужд участников является нашей заботой.Оригинальный текст (англ.)'Policy' should not really concern itself with server load except in the most extreme of cases; keeping things tuned to provide what the user base needs is our job.
Недостатки подстановки
- Единожды раскрытый шаблон становится просто частью кода страницы, на которой он был размещен и больше никак не связан с исходным шаблоном. Из-за этого очень трудно найти страницы, в которые этот шаблон был помещён. Помещая в текст шаблона ссылку на шаблон, можно решить эту проблему.
- Обновление исходного шаблона не затронет раскрытый шаблон. Тот останется таким же, каким был на момент подстановки.
- Массовое раскрытие шаблонов с помощью ботов может привести к усиленной загрузке сервера.
- Подстановка увеличивает размер статей в базе данных, а соответственно дамп базы данных.
- Раскрытый шаблон может добавить на страницу большой кусок текста в викиразметке или HTML-кода, что может затруднить распознавание текста технически не подкованным участником.
- Раскрытый шаблон может привести к тому, что новички не научатся обращаться с шаблонами, а станут копировать викикод раскрытых шаблонов.
- Временные шаблоны лучше не раскрывать, так как потом их будет труднее найти и удалить.
- Избегайте использования подстановки шаблонов в примечаниях (теги <ref></ref>), или проверяйте её правильную работу. Ошибка в MediaWiki препятствует разворачиванию некоторых (если не всех) подстановок в примечаниях. См. en:Wikipedia:Footnotes#Known bugs (англ.)
Шаблоны, которые обязательно надо раскрывать
- {{w}} — шаблон приветствия новичков
- {{afd}} — К удалению
- {{afi}} — К улучшению
- {{АИ}} — запрос авторитетных источников с постановкой текущей даты
Шаблоны, которые не следует раскрывать
- {{Навигационная полоса}}
- {{Навигационная таблица}}
- {{Карточка}}
