Руководство по редактированию Википедии и страница справки
Замена — это другой способ обработки шаблонов , чем обычно делается в Википедии. Обычно шаблоны включаются , что означает, что если шаблон изменится, каждая страница, которая его использует, обновится, чтобы соответствовать рассматриваемому изменению. Это процедура, используемая для большинства шаблонов. Однако некоторые шаблоны вместо этого заменяются. Это означает, что если шаблон изменится, страница, которая его использует, не изменится и продолжит показывать старую версию шаблона. Некоторые шаблоны всегда следует заменять, в то время как большинство всегда следует включать.
Чтобы заменить, добавьте subst:после открывающих скобок, как в {{subst:page name}}. Например: подстановка {{subst:Medicine}} в отличие от включения {{Medicine}} . Содержимое Template:Medicine будет расширено (для любых шаблонов) и сохранено в каждой точке, где "{{subst:Medicine}}" размещается на странице. Обратите внимание, что теги ссылок отказываются запускать "subst:", если они временно не переименованы в " <xref name=xx>" или аналогично (см. отчет об ошибке в T4700).
На этой странице также перечислены шаблоны, которые должны либо всегда, либо никогда не заменяться, за исключением пространства имен Wikipedia. Автоматизированные инструменты (также известные как боты ), которые выполняют такие замены, никогда не будут использоваться в исходном шаблоне. Если вы собираетесь использовать бота для замены шаблонов, пожалуйста, сначала прочитайте страницу обсуждения , так как многие из них являются предметом спора или меняют статус с течением времени, а замена является постоянной.
О субст:
Определение
Ключевое subst:слово (сокращение от «substitution») используется внутри кода шаблона , помещается как префикс перед именем шаблона, но внутри фигурных скобок ( {{}}). Оно изменяет способ, которым программное обеспечение MediaWiki расширяет шаблон.
Обычно шаблон будет расширяться "на лету"; то есть код шаблона на странице вызывает отдельную страницу каждый раз, когда он отображается. Хотя большинство просмотров страниц обслуживаются из кэша, страницы необходимо отображать для предпросмотра и отображать снова при изменении страницы. Когда кто-то редактирует страницу с помощью обычного вызова шаблона, он видит вызов шаблона.
Размещение "subst:" внутри фигурных скобок сообщает программному обеспечению о необходимости постоянной замены шаблона текстом шаблона (т. е. текстом, который находится на странице статьи шаблона , когда шаблон добавляется на страницу ). Таким образом, {{template}} становится {{subst:template}}, пока вы не сохраните страницу. Следующий редактор видит не вызов шаблона, а текст шаблона, когда вы его сохранили; он не меняется, даже если исходный шаблон редактируется.
Использование
Вы можете заменить тег шаблона, добавив к нему "subst:". Например, используйте {{subst:test5}} вместо {{test5}}.
Если это важный компонент редактирования, настоятельно рекомендуется упомянуть шаблон в сводке редактирования (например, указать «{{subst:test}}», «subst:test» или «test1 applied» в сводке редактирования), чтобы другие редакторы могли легко увидеть, что вы сделали.
Кроме того, при создании или редактировании шаблонов, которые часто заменяются, добавление скрытого комментария на страницу шаблона помогает редакторам статей видеть, как используются шаблоны (например ). Используйте {{ subst:html comment }}, если вы хотите писать HTML-комментарии, содержащие расширения викитекста.<!-- Substituted from Template:Documentation -->
Преимущества
- Если есть шаблон, который вы хотели бы изменить для одного случая, но вы не хотите изменять шаблон для всех страниц, которые его используют, и вы не хотите создавать новый шаблон, вы можете заменить шаблон, а затем со вторым редактированием внести изменения. Например, шаблон может использоваться со всеми штатами США и с округом Колумбия. Шаблон может быть сформулирован правильно для штатов, но не для округа Колумбия. Чтобы исправить формулировку, вы можете заменить шаблон, а затем исправить формулировку.
- Замена часто используемых, но незащищенных шаблонов ограничивает ущерб, который может быть нанесен людьми, испортившими шаблон. См. шаблоны с высоким риском .
- Исключение определенных шаблонов скрывает вики-текст от новичков, тогда как замена делает вики-текст видимым и дает им возможность изучить его использование (конечно, внизу каждой страницы редактирования есть ссылка «как редактировать»).
- Подстановка позволяет выполнять рекурсивную оценку с помощью шаблонов макросов.
Нейтральный
- Массовая замена может в конечном итоге ускорить сайт, но это не причина предпочитать замену трансклюзии. Не беспокойтесь о производительности серверов Википедии.
- Шаблоны часто изменяются или удаляются. Если шаблон представляет собой шаблонный текст , подумайте, хотите ли вы, чтобы он менялся по мере изменения шаблона. Если ваш ответ «нет», замена оправдана. Примером этого является шаблон {{ subst:welcome }}. Архивы страницы обсуждения пользователя должны отображать фактическое приветственное сообщение, которое он получил, а не текущее приветственное сообщение.
Недостатки
- После замены шаблона результат больше не связан с шаблоном, что затрудняет поиск всех страниц, отображающих этот текст (хотя категории иногда могут облегчить эту задачу). Эту проблему можно легко обойти, включив ссылку на шаблон в код шаблона.
- Замененный шаблон не будет обновлен после исправления ошибок в основном шаблоне.
- Если шаблон используется для стандартизации внешнего вида чего-либо, вы, вероятно, не захотите делать замену. Примером этого является оглавление или навигационное поле.
- Массовая замена — редактирование тысяч статей с помощью ботов — временно замедляет работу сайта и приводит к неоправданной трате ресурсов сервера.
- Замена увеличивает размер статей в базе данных и дампов базы данных.
- Замененный шаблон может добавить в статью много вики-кода или HTML, что ухудшит доступность статьи для менее технически подкованных пользователей.
- Подстановка шаблонов не позволяет новичкам научиться пользоваться шаблонами, а пользователям — находить нужную документацию.
- Если шаблон используется временно, то лучше его не заменять. Замененные шаблоны гораздо сложнее удалить или изменить.
- При замене испорченного шаблона его сложнее исправить, чем при обычном вандализме, из-за отсутствия связей между шаблоном и его воплощениями, а также из-за отсутствия возможности обновления.
- Некоторые меташаблоны, такие как {{!}} и {{ (( }} , не работают, если их заменить.
Шаблоны, которые должнывсегдабыть замененным
Это список шаблонов, которые всегда должны быть заменены, организованный по пространству имен . Каждый список упорядочен в алфавитном порядке с сгруппированными сериями. Это не полный список ; другие менее используемые шаблоны также могут нуждаться в замене, подробности см. в документации шаблона.
Пространство имен статьи
- {{ Больше ссылок нет }} , замена этого вставляет комментарий, видимый только в режиме редактирования, с кратким пояснением, чтобы воспрепятствовать спам-ссылкам.
Статья разговор
Пространство имен разговоров пользователей
Все шаблоны, перечисленные в Категория: Шаблоны предупреждений пользователей и Категория: Шаблоны приветствия, должны быть заменены. Это не относится к шаблонам на странице пользователя.
Пространство имен файлов
Разные шаблоны
- Шаблоны подписей пользователей, если они включены, вызывают чрезмерную нагрузку на сервер, поскольку изменения в незначительном шаблоне пользователя должны затем широко распространяться. Если они используются, шаблоны подписей пользователей должны быть заменены. (Однако следует отметить, что шаблоны подписей пользователей не приветствуются .)
Некатегоризованные предложения
Шаблоны, которыедолженбыть замененным
Эти шаблоны имеют цель и/или синтаксис, требующие их замены.
- {{ afd }} , иначе ссылка на «запись этой статьи» не работает.
- {{ cfd }} , {{ cfr }} , {{ cfm }} , которые вставляют комментарии, служащие очередями для Cydebot , который используется для переименования или объединения категорий.
- {{ copyvio }} , для статей, которые должны быть перечислены в разделе «Проблемы с авторскими правами» , при включении в список будет выдано сообщение об ошибке.
- {{ nld }} , для изображений без информации об авторских правах, добавляет {{ no license }} с автоматически заполненной сегодняшней датой.
- {{ nrd }} для изображений без обоснования добросовестного использования добавляет {{ no reasonale }} с автоматически заполненной сегодняшней датой.
- {{ nsd }} , для изображений без информации об источнике, добавляет {{ di-no source }} с автоматически заполненной сегодняшней датой.
- {{ orfud }} для «общих» потерянных изображений добросовестного использования добавляет {{ di-orphaned fair use }} с автоматически заполненной сегодняшней датой.
- {{ or-fu-re }} — для добросовестно используемых изображений, которые были потеряны в пользу другого изображения, добавляет {{ di-orphaned fair use }} с автоматически заполненной сегодняшней датой (в качестве параметра принимает имя заменяющего изображения).
- {{ proposed deletion }} , для предлагаемого удаления, добавляется {{ proposed deletion/dated }} с автоматически заполненной сегодняшней датой.
- {{ requested move }} , для запроса перемещения страниц
- {{ rfd }} , перенаправления для обсуждения
- {{ rfu }} , для добросовестного использования изображений, которые можно заменить бесплатным лицензионным изображением, добавляется {{ replaceable fair use }} , при этом автоматически заполняется текущая дата.
- {{ refu-c }} , используемый в подписях к изображениям, помеченным как заменяемое добросовестное использование, добавляет {{ rfu-c }} с «датой выполнения» (сегодня + 7 дней), которая автоматически рассчитывается и заполняется.
- {{ OnProd }} , который вставляет зависящее от сегодняшней даты название страницы категории, на которую была добавлена статья при ее номинации на удаление.
Шаблоны, которые должнынетбыть замененным
Технически, шаблоны не следует заменять, если:
- содержат вызовы ParserFunctions (
#if, #switch, и т.д.), если только они не замещены, где это возможно (см. mw:Manual:Substitution#Multilevel substitution) - оставить некоторые параметры по умолчанию, не указывая их, если только не используется альтернативный механизм по умолчанию
- содержать внешние ссылки, поскольку форматирование URL-адреса для выполнения запросов или поиска может измениться
Это связано с тем, что эти конструкции не заменяются в сгенерированном вики-коде (одноуровневая подстановка случая (A) оставляет конструкции #ifor #switchдословно в месте subst, а (B) оставляет конструкции типа {{{1|default value}}}).
Если конкретный консенсус заключается в том, чтобы исключить конкретный вызов такого шаблона, можно использовать Special:ExpandTemplates для расширения этого вызова до простого вики-синтаксиса.
Список
Это список шаблонов, которые не следует заменять. Это связано с тем, что они содержат стандартный код форматирования, сложный код или код, который ломается при замене.
- Различные шаблоны цитирования/ссылки, содержащие очень сложный условный код (см.: WP:CITET ).
- Шаблоны инфобоксов , различные для идентификации ботов и обеспечения единообразия.
- {{ Javadoc:EE }} , {{ Javadoc:SE }} , {{ Javadoc:SE-guide }} , условные шаблоны, целью которых является обновление ссылок при обновлении основного шаблона.
- {{ ISP }} , {{ Openproxy }} , {{ repeat vandal }} , {{ SharedIP }} , {{ SharedIPEDU }} , {{ s/wnote }} , а не сообщения пользователям (поэтому не будет проблемой, если они изменят свою первоначальную форму), поэтому нет причин для замены, но применяются стандартные причины не для замены.
- {{ ln }} , {{ lnt }} , сложный код
- {{ Main }} , поддерживает стандарт форматирования.
- {{ switch }} , также условные шаблоны; замена прерываний использования
- {{ См. также }} , стандартное форматирование для списка «См. также»
- {{ selfref }} , не работает при замене, так как он предназначен для хранения другого кода в зеркалах.
- {{ Signpost-subscription }} , необходимо обновлять еженедельно.
- {{ stub }} шаблоны, различные для упрощенного использования и удаления
- {{ talkarchive }} , {{ archive }}
- {{ tl }} , {{ tlp }} , {{ ttl }} , {{ ti }} , {{ tic }} , {{ tls }} , {{ cl }} , {{ ccl }} , многие очень широко используются, {{ tl }} с более чем 7 210 000 трансклюзий по последним подсчетам. Быстрее вводить, чем их замены, и отсутствие подстановки позволяет новым википедистам узнать о них и иметь возможность использовать их.
- {{ sockpuppet }} и аналогичные шаблоны, предназначенные для размещения на странице верхнего уровня в пространстве пользователя. (Примечание: предупреждения и уведомления в пространстве обсуждения пользователя следует заменить.)
Обратите внимание, что некоторые вещи могут казаться шаблонами, но на самом деле являются магическими словами , например {{!}} и {{noexternallanglinks}} . Их замена либо ничего не выведет, либо заменит шаблон, который их затмит (например, устаревший Template:! ).
Неправильные шаблоны заголовков
Эти шаблоны, используемые в основном пространстве, добавляют комментарий о том, почему статья названа неправильно. Они могут быть удалены по мере улучшения возможностей MediaWiki по присвоению названий, а формулировка/макет могут измениться.
Удаление, связанное
Большинство шаблонов, связанных с переименованием или удалением страниц, используются временно, и поэтому не требуют замены (их удаление просто усложняет работу).
- Исключения
Для корректной работы необходимо заменить следующие шаблоны :
Кроме того, следует заменить те шаблоны, которые документируют завершенный процесс удаления ( {{ afd top }} и т. д.).
В стадии обсуждения
Смотрите также
