Тептар:Рекомендации по созданию шаблонов

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

Когда желательно применять метод

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

• когда шаблон включен в тысячи страниц;
• когда шаблон вызывает функции парсера, видоизменяя результат работы шаблона в зависимости от множества параметров и используя условные операторы и операторы ветвления.

Как создать подстраницы /песочница и /тесты

Существует два способа создать песочницу и страницу тестов:

• Если у интересуемого шаблона есть документация, включенная через шаблон {{doc}}, то нижний колонтитул документации будет содержать вспомогательные ссылки для создания песочницы и тестов; при этом создание подстраницы песочницы через вспомогательные ссылки автоматически скопирует содержимое шаблона в страницу редактирования песочницы, а для подстраницы тестов — добавит шаблон сообщения {{тесты шаблона}};
• Если вы хотите создать страницы самостоятельно, то рассмотрим, например, шаблон Шаблон:Х:

1. Необходимо создать подстраницы с именами Шаблон:Х/песочница и Шаблон:Х/тесты, обращая внимание, что имена подстраниц записываются целиком строчными буквами;
2. Скопируйте код из шаблона Шаблон:Х на страницу Шаблон:Х/песочница;
3. Если в коде шаблона тегом <noinclude> окружено лишь включение шаблона {{doc}}, то скопируйте код целиком, иначе — только лишь код, не окружённый тегом <noinclude>, добавив следующий код в конец: <noinclude>
{{песочница шаблона}}
</noinclude>
4. Скопируйте несколько случаев использования шаблона ({{Х| .... }}) со страниц статей, его включающих, на страницу Шаблон:Х/тесты;
5. На странице Шаблон:Х/тесты продублируйте каждый случай использования шаблона, заменив вызов шаблона Х на Х/песочница, чтобы можно было сравнить результат работы старого и обновлённого шаблонов;
6. Добавьте также шаблон сообщения тестовой страницы на подстраницу Шаблон:Х/тесты:{{тесты шаблона}}

Как использовать в дальнейшем

• Скопируйте текущую версию шаблона в песочницу (см. пункты 2—3 выше).
• Проделайте изменения в песочнице.
• Проверьте результаты на странице тестов.
• Если всё в порядке, скопируйте новый код из песочницы обратно в шаблон.

См. также

• Правила защиты критических шаблонов
• {{песочница шаблона}} — сообщение песочницы
• {{тесты шаблона}} — сообщение подстраницы тестов
• {{TestCase}} — для упрощения тестирования функциональных шаблонов
• {{Тесты шаблона таблицей}} — особенно для карточек