Энциклопедия:Правка и тестирование шаблонов в песочнице

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

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

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

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

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

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

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

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

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

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

Примеры

• {{HumanizeDate}}: песочница и тесты.

См. также

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