Користувач:Ickis/Рекомендації щодо створення шаблонів

Рекомендації

Обирайте зрозумілі назви

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

Використовуйте мета-шаблони

Не забувайте, що є шаблони {{картка}}, {{навігаційна таблиця}}, {{навігаційна смуга}}, {{ambox}}, {{userbox}} та інші. Таке використання 1) допомагає впровадженню нових технологій в існуючу систему шаблонів, 2) дозволяє легко змінювати стилі оформлення (як глобальні, так і для окремих користувачів).

Використовуйте осмислені CSS-класи

Не треба використовувати клас infobox для навігаційної смуги тільки тому, що він вам підійшов за кольором. Також не потрібно оздоблювати навігаційні шаблони, користуючись класом wikitable. Є один достатньо універсальний клас — standard, всі інші мають власне призначення. Це означає, що 1) їх потрібно використовувати в тих шаблонах, для яких вони призначені (навіть якщо вони вам не повністю підходять, дрібниці можна виправити за допомогою стилів), 2) не варто використовувати їх в інших шаблонах.

Додавайте документацію

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

Катигоризуйте шаблони

Не забувайте категоризувати шаблони, включаючи категорії в <noinclude>. Для деяких шаблонів також буде корисна категоризація статей, в які вони включаються, з використанням <includeonly>.

Не використовуйте застарілі шаблони

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

Не створюйте схожі шаблони

Завжди прагніть уніфікації шаблонів. І обов'язково перевіряйте, чи не існує вже шаблон для вашого завдання. Можливо, має сенс допрацювати існуючий замість того, щоб створювати новий. Якщо п'ять шаблонів відрізняються одним полем, то простіше і зручніше задати це поле параметром. При цьому 1) доведеться підтримувати і розвивати тільки один шаблон, 2) редакторам не доведеться плутатися з тим, що схожі шаблони мають різний устрій (а при довготривалому паралельному розвитку в кожний з них додаватимуться параметри, які не будуть перенесені в інші шаблони. Часто трапляється, що у результаті однакові по сенсу параметри в різних шаблонах мають різні назви). Якщо об'єднати шаблони складно, варто подумати про власний мета-шаблон.

Не створюйте тривіальні шаблони

Буває, що створюються і навіть масово використовуються шаблони, назва яких лише трохи коротша за їх код, а іноді навіть довше. Така практика зазвичай є невдалою. Але можуть бути і винятки:

1. якщо планується часто міняти невелику частину шаблону, то це дозволить не засмічувати його історію правок;
2. якщо таке використання дозволяє уніфікувати оформлення.

Підписуйте зображення

Ніколи не робіть порожнім опис шаблону:

[[Файл:Example.jpg| ]]

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

Див. також

• Довідка:Шаблони
• Довідка:Парсерні функції
• Довідка:Магічні слова

Використано матеріали зі російської Вікіпедії