Вікіпедія:Шаблони

Про принципи роботи шаблонів Вікіпедії див. Довідка:Шаблони.

Шаблони — спеціальні сторінки Вікіпедії, що містять вікірозмітку, призначену для зображення на багатьох сторінках, зазвичай за допомоги включення. Призначення шаблонів — розширення функцій рушія Вікіпедії. Шаблони містяться у просторі назв «Шаблон». Хоча простір назв шаблонів охоплює абсолютну більшість шаблонів, існує можливість включення й підстановки з інших просторів назв[1], тому деякі сторінки-шаблони розташовані в інших просторах назв, наприклад, на сторінках користувачів.

Шаблони допомагають підтримувати цілісне форматування та сприяють навігації між статтями. Вони також містять додаткові та/або змінні елементи, що керуються за допомоги параметрів для можливості спеціалізованого використання. Шаблони також слугують багатьом завданням підтримки Вікіпедії. Кожен шаблон має відповідну сторінку обговорення Обговорення шаблону:, на якій дописувачі можуть обговорювати дизайн і використання шаблону (див. Довідка:Сторінки обговорення, аби дізнатися, як брати участь в обговореннях на цих сторінках).

Шаблон включається до іншої сторінки за допомоги вставлення шаблонного тегу в код сторінки. Шаблонний тег являє собою назву шаблону в подвійних фігурних дужках, наприклад: {{Документація}}.

Внутрішні посилання на шаблони оформлюються за допомоги Шаблон:, наприклад: [[Шаблон:Документація]]. Ці посилання ведуть на сторінку, що безпосередньо містить шаблон, а часто й супутню документацію.

Використання

  • Користуйтеся наявними шаблонами та за потреби створюйте нові.
  • Зазвичай шаблони не слід використовувати для складува́ння тексту статей, оскільки це ускладнює редагування їхнього вмісту. Їх також не слід використовувати для згортання («collapse») або приховання («hide») вмісту від читача.
  • Навігаційні, форматувальні шаблони та шаблони-попередження створені та використовуються в статтях для допомоги й інформування читачів. Шаблони, що містять інформацію, яка може бути корисною лише для дописувачів, не мають розміщуватися в статтях — використовуйте в цих випадках сторінки обговорення чи інші простори назв.
  • Призначення шаблону має бути очевидним з його назви, однак можна створювати коротші перенаправлення для зручнішого використання найпопулярніших шаблонів.
  • Шаблони з високим ризиком мають бути частково або повністю захищеними відповідно до важливості й широти вжитку (див. Вікіпедія:Правила захисту сторінок). Це так само стосується будь-яких широковживаних перенаправлень на шаблони.
  • Шаблони мають містити чітку документацію з указанням їхнього функціоналу та призначення.
  • Шаблон не слід використовувати для створення списків посилань на інші статті, якщо категорії, списки чи розділ «Див. також» можуть виконувати цю ж функцію.
  • Шаблони для коротких, тимчасових повідомлень, які швидко прибираються (як на підсторінках обговорення користувачів), або шаблони, що містять текст, що найімовірніше ніколи не буде змінено, мають використовуватися з підстановкою (subst:). Типові шаблони, які призначені для довготривалого використання та, ймовірно, зазнаватимуть змін, слід використовувати з включенням для легкості подальших оновлень.
  • Шаблони, що порушують ці настанови, мають сумнівне призначення, непотрібні, ізольовані, використані лише на одній сторінці, або такі, що порушують інші правила та/або настанови Вікіпедії, треба номінувати на вилучення на сторінці Вікіпедія:Статті-кандидати на вилучення.

Особливості

Посилання на шаблони

Іноді треба послатися на шаблон, а не включити його чи підставити. За допомоги шаблону:Tl (скорочення від англ. template link — посилання на шаблон) можна це легко зробити. Наприклад, аби послатися на шаблон:Упорядкувати, введіть {{tl|Упорядкувати}} — вийде {{Упорядкувати}}. Також можна додавати параметри за допомоги шаблону:Tlp; наприклад, {{tlp|Convert|1|m}} виглядатиме як {{Convert|1|m}}.

Назви шаблонів

Див. також: Вікіпедія:Іменування статей#Назви шаблонів і зображень

Найкраще, коли шаблони мають зрозумілі українські найменування, з яких зрозуміло призначення шаблону. Проте, запозичені шаблони, меташаблони, і такі, що широко використовуються в інших мовних розділах Вікіпедії, можуть зберігати оригінальні назви.

Назви шаблонів можуть складатися з одного чи декількох слів, як, наприклад, {{Мовні помилки}}. Окрім першого символу назви, малі та великі літери сприймаються по-різному — наприклад, {{Стиль}} і {{стиль}} включатиме той самий шаблон, тоді як {{Bgr}} і {{BGR}} являють собою включення двох різних, не пов'язаних між собою шаблонів. Уникайте подібності в назвах шаблонів, які відрізняються лише регістром літер, пунктуацією тощо.

Пісочниця для тестів

Докладніше: Вікіпедія:Редагування і тестування шаблонів у пісочниці

Якщо ви бажаєте проекспериментувати із шаблонами (і не втратити свої зміни ще перед тим, як закінчити), використовуйте пісочницю шаблонів або власну чернетку.

Часто існуючі шаблони мають власні підсторінки пісочниці й тестів (особливо ті, що використовують {{Документація}}). Перед оновленням власне шаблону, зміни слід ретельно протестувати для запобігання можливої шкоди багатьом сторінкам.

Читабельність

У шаблонах, які використовують велику кількість параметрів, варто розмістити кожен параметр на окремій лінії, вирівнявши знаки рівності. Це допомагає дописувачам легше прочитати вікірозмітку. 

{{Назва-приклад шаблону
| перший_параметр  = Текст першого значення
| другий_параметр  = Текст другого значення
| третій_параметр  = Текст третього значення
| тощо             = тощо
}}

Розрив рядків

Деякі шаблони можуть випадково спричиняти розриви рядків на сторінках, де вони застосовані. Це особливо стосується шаблонів-карток та інших шаблонів-контейнерів, які зазвичай прилягають до правого краю сторінки, оскільки додаткові рядки не видно на сторінці шаблону чи на підсторінці документації в його тестовому використанні.

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

Підстановка

Докладніше: Вікіпедія:Підстановка

Використання шаблону за допомоги коду {{subst:назва шаблону (|параметри |...)}} (тобто вставлення subst: одразу після першої пари фігурних дужок) створить копію вмісту шаблону в коді сторінки. Цей шаблон більше не включатиметься на сторінці, а подальші зміни коду шаблону не змінять уже підставлений вміст.

Загальна рекомендація: цей метод слід застосовувати для будь-яких коротких, тимчасових повідомлень, які швидко прибираються (як на підсторінках обговорення користувачів). Шаблон привітання нового користувача {{Welcome}} є гарним прикладом.

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

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

Докладніше: Вікіпедія:Документація шаблонів

Оскільки дописувачі-початківці можуть відчувати підвищену складність у роботі з шаблонами, варто створювати документацію їхнього функціоналу (параметри) і додавати опис їхнього призначення (де застосовувати). В українській Вікіпедії для цього використовується спеціально призначений шаблон {{Документація}}, який має наступні варіанти застосування:

Із підсторінкою

Використовується, якщо шаблон достатньо специфічний і місткий, аби мати власну підсторінку документації. Для цього до коду редагованого шаблону в кінці додається шаблон {{Документація}}: <noinclude>{{Документація}}</noinclude>. Опісля підсторінку необхідно створити — для цього натисніть [створити] зверху шаблону документації, або зробіть це власноруч.

Приклад: Нехай шаблон називається Шаблон:X. Тоді підсторінка має називатися Шаблон:X/документація — українською, з малої літери[2] — і на ній треба додати специфіку використання шаблону та опис його параметрів. Для включення документації на сторінці шаблону, на ній має бути проставлене включення шаблону {{Документація}} таким чином, як наведено в попередньому абзаці. Після цього на сторінці шаблону Шаблон:X у зеленому віконці відображатиметься його документація.

Без підсторінки

Використовується, якщо потрібна документація закоротка для створення окремої підсторінки, тобто її обсяг не перевищує двох-трьох рядків. Використовуйте {{Документація|текст=}} — це не створює окрему сторінку документації, адже документація наводиться безпосередньо на сторінці редагованого шаблону. Така документація називається інлайн-документацією.

Інлайн-документація не має містити лише категорії!

Нерідко буває, коли шаблон зазнає змін, а документація продовжує відображати застарілі особливості використання шаблону. Якщо ви помітили невідповідність між кодом шаблону та його документацією, будь ласка, виправте її, якщо маєте розуміння та достатні вміння, або повідомте про це в технічній Кнайпі чи досвідченішим редакторам шаблонів.

Модулі

Докладніше: Вікіпедія:Модулі

Модулі Lua іноді використовуються замість шаблонів для консолідації багатофункціонального коду. Причинами цьому слугує використання специфічних для модулів рис, таких як петлі чи збережені значення; також складний код часто легше читати та підтримувати в модулі. Якщо модуль легко подати у вигляді шаблону, треба віддати перевагу шаблонові, оскільки набагато більше дописувачів мають технічні знання для їхнього редагування, порівняно з модулями.

Якщо модуль має застосовуватися на сторінках основного простору чи в обговореннях, для простішого використання слід створити шаблон-прокладку, який виконує код модуля замість безпосереднього використання функції парсера #invoke. У таких випадках документація майже завжди розташовується на підсторінці документації шаблону, із посиланням докуменації модуля на документацію шаблону та/або поясненням подальших технічних подробиць, які не потрібні на підсторінці документації шаблону.

Однак є причини не використовувати такі шаблони-прокладки — наприклад, потенційні проблеми, пов'язані з технічними обмеженнями шаблонів; використання шаблону-прокладки з надлишком параметрів набагато менше ефективне, ніж пряме виконання коду модуля. Крім цього, зазвичай не бажано використовувати шаблони-прокладки в інших шаблонах.

Категоризація

Докладніше: Вікіпедія:Категоризація

У процесі створення шаблону категоризуйте його за допомоги додавання коду: <noinclude>[[Категорія:Шаблони:<тема>]]</noinclude> щонайменше в одну з підкатегорій категорії «Шаблони».

Якщо шаблон має підсторінку документації[⇨], розмістіть категорію наприкінці підсторінки документації за допомоги додавання коду: <includeonly>[[Категорія:Шаблони:<тема>]]</includeonly> щонайменше в одну з підкатегорій категорії «Шаблони».

Категорії для шаблонів

Категорії простору назв шаблонів називаються із префіксами штучного підпростору назв, через двокрапку. Нижче наведені приклади іменування категорій шаблонів із відповідними батьківськими категоріями:

Така стандартна схема іменування категорій значно спрощує пошук категорій і дозволяє автоматизувати маніпуляції з просторами назв (наприклад, див. Категорія:Шаблони для маніпуляцій з простором).

В інших вікіпроєктах (напр. англійська Вікіпедія) такого стандарту іменування категорій шаблонів не існує.

При створенні категорії шаблонів, будь ласка, позначте її шаблоном {{Категорія шаблонів}} або {{Навігація для категорій}} з їхніми відповідними параметрами.

Метакатегорії, або категорії-контейнери для шаблонів

Категорії-контейнери або метакатегорії — це такі категорії, що містять лише підкатегорії і групують їх (підкатегорії) за певною ознакою.

Головні метакатегорії шаблонів:

Усі категорії шаблонів, які позначені шаблоном {{Категорія шаблонів}} потрапляють у метакатегорію спостереження Категорія:Категорії шаблонів Вікіпедії (3492).

Шаблони, що додають категорію

Деякі шаблони автоматично додають категорії на сторінки, у які вони включені. Для можливості вимкнення категоризації сторінки власного включення шаблон повинен обробляти стандартизований параметр |nocat= (аналог булівського типу даних, де умовою true є наявність будь-якого вмісту), який залишається невизначеним або визначеним порожнім. Його слід заповнювати лише при використанні шаблону на сторінках, на яких треба вимкнути автоматичну категоризацію цим шаблоном.

Пошук шаблонів

Тут можна скористатися пошуком у просторі назв Шаблон:

Для зручності користування, шаблони окрім категорій наведені також на оглядових сторінках (підсторінках цієї сторінки) та згруповані за темами, а також в категорії Категорія:Списки шаблонів (62).

Див. також: Довідка:Шаблони, Вікіпедія:Запити на шаблони та Вікіпедія:Шпаргалка

Авторські права

Адміністрування

Багатозначність

Докладніше: Категорія:Шаблони багатозначності і перенаправлень (43)
Шаблон Вигляд
{{Disambig}}
{{DisambigG}}
{{DisambigF}}
(для прізвищ)
{{DisambigN}}
(для тезок і повних тезок)
{{Otheruses}}
{{Otherpersons|<ім'я та прізвище>}}
Щодо інших людей з таким самим іменем та прізвищем див. (ім'я та прізвище).
{{Othernames|<прізвище>}}
У Вікіпедії є статті про інших людей із прізвищем (прізвище).
{{About|1|2|3}}
Ця стаття про 1. Про 2 див. 3.
{{For|1|2|3}}
Про 1 див. 2 та 3.
Шаблон Вигляд
{{Докладніше}}
Докладніше: [[|]]
{{Докладніше1}}

Детальніші відомості з цієї теми ви можете знайти в статті {{{1}}}.

Незавершені статті

Докладніше: Вікіпедія:Шаблони:Незавершені статті

Недосконалість статей

Докладніше: Вікіпедія:Шаблони впорядкування та Вікіпедія:Встановлення шаблонів упорядкування

Шаблони для категорій

Докладніше: Категорія:Шаблони простору назв категорій (235)

Стиль

  • {{TOC right}} — TOC (зміст) плаваючий у правому верхньому куті, зручний для використання з довгими вузькими таблицями змісту.
  • {{2}}/{{3}}/{{4}} — шаблони для розбиття тексту на 2/3/4 стовпці.
  • {{Легенда}} — показує рядок легенди з кольоровим квадратиком.

Мова

Навігаційні

Категорія:Навігаційні шаблони (97) {{navbox}}



Наука

Україна

Інформатика

{{{4}}}



Картки

Докладніше: Вікіпедія:Шаблони/Картки

Картки — шаблони, що наводять стандартизовану інформацію про предмет статті. Картки можуть бути «довільної форми» або частково автоматизовані на основі параметрів.

Використання шаблону-картки у будь-якій статті не є обов'язковим, але і не заборонене. Питання, чи використовувати шаблон-картку, яку шаблон-картку використовувати, та які частини картки використати, визначається через обговорення та прийняття консенсусного рішення серед редакторів, по кожній окремій статті.

Див. також

Загальні

Спеціальні

Спільнота Вікіпедії

Обговорення, голосування

Докладніше: Вікіпедія:Шаблони/Обговорення

Юзербокси користувачів

Категорія:Юзербокси (109) та її підкатегорії містять невеличкі шаблони, якими користувачі можуть заявити про приналежність до певної групи: за місцем народження, інтересами, внеском, і так далі й тому подібне. Див. списки юзербоксів за темами ↓

Див. також

Примітки

  1. ↑ Простори назв, з яких не можна включати сторінки, зазначені тут
  2. ↑ Затверджена постійна версія № 25616110#Найменування підсторінок документації шаблонів — підсумок