Википедия: пространство имен шаблонов

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

Ярлыки WP: TMP WP: NS10

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

Имена Шаблона в Википедии используются для хранения шаблонов , которые содержат Wiki разметку , предназначенную для включения в нескольких страницах, как правило , через перенаправление . Хотя пространство имен Template используется для хранения большинства шаблонов, его можно включать и заменять из других пространств имен, ^[1] и поэтому некоторые страницы шаблонов помещаются в другие пространства имен, такие как пространство имен User .

Шаблоны помогают поддерживать единообразное форматирование и облегчают навигацию между статьями. Они часто включают в себя необязательные и / или переменные элементы, управляемые параметрами, для специального использования. Шаблоны также используются для помощи в большом количестве задач по обслуживанию Википедии . У каждого шаблона есть соответствующая Template talk:страница, где редакторы могут обсудить дизайн и реализацию связанного шаблона (см. Справка: Использование страниц обсуждения, чтобы узнать, как участвовать в обсуждениях страницы обсуждения).

Шаблон включается на другую страницу путем включения тега шаблона в содержимое этой страницы. Тег шаблона содержит имя страницы шаблона, окруженное двойными фигурными скобками, например {{Disambiguation}}. Если имя страницы шаблона не начинается с пространства имен и двоеточия, предполагается, что оно находится в пространстве имен Template.

Внутренние ссылки на страницы шаблонов могут быть сделаны с использованием Template:префикса, например [[Template:Disambiguation]]. Эти ссылки ведут на страницу, которая непосредственно содержит базовый шаблон и часто документацию .

Руководящие указания

• Шаблоны обычно не следует использовать для хранения текста статьи , так как это затрудняет редактирование содержимого. Их также не следует использовать для «сворачивания» или «скрытия» контента от читателя.
• Шаблоны, используемые в статьях, предназначены для предоставления информации в помощь читателям, например средств навигации, форматирования или предупреждений о том, что контент не соответствует стандартам. Шаблоны, которые предоставляют редакторам только информацию об услугах, не должны появляться на страницах статей - используйте страницу обсуждения статьи или другие пространства имен, не относящиеся к статьям.
• Функция шаблона должна отличаться от имени шаблона , но могут быть созданы перенаправления для повседневного использования очень популярных шаблонов.
• Шаблоны с высокой степенью риска должны быть частично защищены, защищены шаблоном или полностью защищены (см. Википедия: Политика защиты ). Это относится также к любым часто используемым перенаправлениям шаблонов.
• Шаблоны должны быть четко задокументированы относительно их использования и объема.
• Шаблоны не следует использовать для создания списков ссылок на другие статьи, если ту же функцию может выполнять категория , страница списка или список раздела «См. Также» .
• Шаблоны для коротких временных сообщений, которые будут быстро удаляться (например, на страницах User_talk:) или которые содержат текст, который вряд ли когда-либо будет изменен, следует вызывать с заменой (subst :). Типичные шаблоны, которые предназначены для длительного использования и могут потребовать изменений, должны быть включены для упрощения будущих обновлений.
• Шаблоны, которые нарушают правила на этой странице, имеют плохо определенную функцию, являются избыточными, становятся бесхозными или используются только на одной странице или нарушают другие политики Википедии, могут быть номинированы на удаление в Википедии: шаблоны для обсуждения .

Предлагаемые практики

Ссылки на шаблоны

Иногда вам нужно обратиться к шаблону, а не вызывать его. Легкий способ сделать это - вызвать Template: Tl (сокращение от «ссылка на шаблон»). Например, чтобы сослаться на шаблон «Очистка», введите {{tl|Cleanup}}результат в виде {{ Очистка }}. Вы также можете добавить параметры с помощью Template: Tlp ; например, {{tlp|Convert|1|m}}отображается как {{ Convert | 1 | m}} .

Обратитесь к документации по шаблону на Template: Tl, чтобы узнать о других параметрах, таких как {{ tlb }} (жирный шрифт), (код), (параметры курсивом) и многие другие.{{tlx}}{{tlxi|param1|param2}}

Имена шаблонов

Имена шаблонов могут состоять из одного или нескольких слов, например {{Train topics}}. Первый символ (только) не чувствителен к регистру, поэтому {{cleanup}}и {{Cleanup}}являются одним и тем же шаблоном, но {{cfd}}и {{cfD}}не являются. Имена шаблонов легче всего запомнить, если они соответствуют стандартному английскому написанию, пробелам и заглавным буквам (также см. Соглашения об именах для статей). Избегайте использования шаблонов, имена которых отличаются только регистром, пробелами или пунктуацией.

Песочница для экспериментов

Если вы хотите поэкспериментировать с шаблонами (и не удалять свои эксперименты до того, как вы закончите с ними), вы можете сделать это в песочнице шаблонов . Вы также можете использовать шаблоны X1 , X2 , X3 , X4 , X5 , X6 , X7 , X8 , X9 , X10 , X11 и X12 в экспериментальных целях. Чтобы включить тестовый шаблон, используйте форму {{X1}}для шаблона X1, {{X2}}для шаблона X2 и т. Д.

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

Читаемость

Для шаблонов, которые используют большое количество параметров, может быть полезно поместить каждый параметр в отдельную строку и выровнять знаки равенства. Это поможет будущим редакторам легче читать викикод.

{{Пример названия шаблона| first_parameter = Текст first_value| second_parameter = Текст второго_значения| third_parameter = Текст третьего_параметра| и т. д. = и т. д.}}

Разрывы строк

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

Как правило, избегайте двух разрывов строк в шаблоне. Они могут «складываться» с другими разрывами строк в статье и отображаться как нежелательные пробелы.

Замена

Вызов шаблона с помощью формы

{{subst:name of template (|parameters |...)}}

(то есть вставка subst:сразу после открывающей пары фигурных скобок) сделает копию текста шаблона и поместит его на страницу, где он будет доступен для просмотра в исходном тексте. Шаблон больше не включается, и будущие изменения в шаблоне не повлияют на текст. В качестве ориентира этот метод следует использовать для любых коротких временных сообщений, которые удаляются быстро, например, на страницах User_talk :. Стандартное сообщение нового пользователя - хороший пример.{{Welcome}}

Используйте subst: также, если вам нужно отредактировать сообщение после включения его на страницу. Если вам не нужно его редактировать и вы предпочитаете, чтобы сообщение обновлялось автоматически вместе с изменениями, внесенными в шаблон, не используйте subst :.

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

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

Один из альтернативных вариантов - использовать <noinclude> для добавления небольшого описания прямо в шаблон, например:

'' 'Это статья {{{1}}}.' '' <noinclude>Разместите этот шаблон на любой статье, требующей описания. Этопринимает один параметр, прилагательное, используемое для описания статьи. Например, {{article-describe | bad}} выводит текст, '' 'Это плохая статья.' ''</noinclude>

Другой альтернативой является создание формальной подстраницы / doc для документации (предпочтительнее для шаблонов с несколькими параметрами и т. Д.) И добавление после фактического шаблона. Первый тег «noinclude» следует разместить в той же строке, что и конечные фигурные скобки фактического шаблона, следующим образом:<noinclude>{{Documentation}}</noinclude>

{{(Имя Шаблона)(параметры трубопровода)}} <noinclude> ...

Если тег «noinclude» начинается в строке под закрывающими фигурными скобками шаблона, то нежелательные пробелы вводятся в нижней части шаблона, когда он используется в статьях и на других страницах.

История

Исторически сложилось так, что префикс «msg:» должен был быть добавлен перед именем шаблона, когда он использовался на странице. Например, было набрано {{msg: stub}} вместо {{stub}}. В этом больше нет необходимости.

В первые 35 месяцев существования Википедии не было никакого шаблона или механизма включения. Страница Википедия: шаблонный текст была создана в сентябре 2002 года для сбора часто используемого текста в различных процессах Википедии. Пространство имен MediaWiki было введено в MediaWiki 1.2.6 6 декабря 2003 г. и использовалось не только для пользовательского интерфейса, но и для создания шаблонных текстовых сообщений, вставляемых в статьи с использованием синтаксиса {{msg: ...}}. Эта функция была заменена пространством имен Template во время обновления программного обеспечения до MediaWiki 1.3 30 мая 2004 г. Как функция сценария инициализации пространства имен Template", все несистемные сообщения были перемещены в новое пространство имен. Сценарий инициализации также заменил MediaWiki: ссылки в статьях на Template: для обхода перенаправлений, созданных перемещениями.

В течение короткого времени Википедия: статьи для удаления (тогда известные как голоса за удаление или VfD ) использовали MediaWiki: сообщения, названные в формате «MediaWiki: VfD- articlename ». Они были перемещены в пространство Template: в июне 2004 года и получили название «Template: VfD- articlename ». Теперь это использование не рекомендуется в пользу подстраниц.

Примерно в 2005 году растущая сложность функций шаблонов и желание объединить похожие шаблоны привели к созданию чрезвычайно сложных условных хаков, таких как вложенные шаблоны и трюки с CSS . Эти нежелательные методы привели к развитию m: Extension: ParserFunctions , добавленного в 2006 году вместе с MediaWiki 1.7. К 2009 году многие проблемы с удобочитаемостью и сложностью шаблонов все еще оставались (по шаблонам и языкам программирования ). В 2013 году, чтобы уменьшить время загрузки страницы, в основном из-за медленной отрисовки шаблонов, был включен Lua , создавая пространство имен Module: для использования программистами ( новые шаблоны Lua обеспечивают более быстрые и гибкие страницы в вашей вики ).

Поиск шаблонов

Используйте эту форму для поиска в пространствах имен Template: или Template_talk:. См. Раздел « Справка: поиск» для получения дополнительной информации.

Страницы, содержащие информацию о часто используемых шаблонах:

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

Если вы не можете найти существующий шаблон для вашей ситуации, но вам неудобно создавать его самостоятельно, вы можете обратиться за помощью в Википедию: Запрошенные шаблоны .

Смотрите также

• Справка: шаблон для получения информации о разработке шаблонов и деталей синтаксиса.
• Справка: Волшебные слова для всех модификаторов шаблона
• Справка: условные таблицы
• Википедия: стандартизация шаблонов

Примечания