Проект:Технические работы/Оформление шаблонов

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

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

Шаблоны, как правило, именуются на современном русском языке, название начинается с прописной (большой) буквы:

• {{Карточка}}
• {{Население}}
• {{Стрит-арт}}

Примечания

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

Названия из нескольких слов пишутся с соблюдением правил орфографии, но без знаков препинания (см. также ВП:ИС):

• {{Губернаторы Флориды}}
• {{Губернаторы Московской области}}
• {{Численность сельского населения и его размещение на территории Московской области}}
• Y {{Премия Оскар за лучший фильм}}
• {{Премия «Оскар» за лучший фильм}}

Допускается именование шаблонов с сокращением слов, при этом каждое слово в сокращении начинается с прописной буквы, пробелы и знаки препинания между сокращёнными словами не ставятся:

• {{ПозКарта}}
• {{НП}}
• {{РМС Австралии}}

Основные исключения составляют шаблоны, состоящие из одной-двух букв, шаблоны общепринятых сокращений и служебные шаблоны: {{Y}}, {{ISBN}}, {{(!}}.

Варианты шаблона нумеруются арабскими цифрами, пробел перед цифрой не ставится:

• {{НП2}}
• {{Разведчик1}}
• Y {{Не переведено5}}, {{Не переведено 5}}

Примечание — Нумерацию рекомендуется начинать с единицы (1).

Именование параметров

Параметры шаблонов, как правило, именуются на современном русском языке, название начинается со строчной (маленькой) буквы:

• изображение
• издательство
• год

В отличие от названий шаблонов, параметры являются регистрозависимыми: Y изображение и Изображение — это разные параметры.

В параметрах, состоящих из нескольких слов, между словами ставится знак подчёркивания:

• Y годы_активности
• годы активности

Стандартные имена параметров

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

• изображение — изображение основного предмета статьи, заменяет фотография, файл и т. п.
• описание — описание изображения, заменяет подпись, описание изображения и т. п.
• ширина — размер изображения, заменяет размер, ширина изображения и т. п.
• название — название на русском языке, заменяет РусНаз, русское название и т. п.
• оригинал_названия — название на исходном языке, заменяет ОригНаз, оригинальное название (в том же смысле) и т. п.
• имя — имя персоналии на русском языке
• оригинал_имени — имя персоналии на исходном языке
• викисклад, викитека, викисловарь... — ссылки тематические проекты фонда Викимедиа: полное русское наименование проекта строчными буквами
• isbn — для указания ISBN.

Отступы и переводы строк

Для удобства чтения шаблоны рекомендуется форматировать с помощью отступов и переводов строк следующим образом:

• В коде шаблона и вне основного текста статьи — вертикально:

{{Шаблон
| название          =
| оригинал_названия =
| изображение       =
| описание          =
}}

• в основном тексте статьи — в строку:

{{Шаблон | название = | оригинал_названия = | изображение = | описание = }}