|
Это страница с руководством WoWWiki. Оно отображает одобренные большинством редакторов стандарты поведения и не является правилом.
|
В этих рекомендациях описываются принципы грамотного написания шаблонов для WoWWiki. Описанные здесь принципы – это руководства к действию на основании уже пройденного практического опыта, а не свод жёстких правил, поэтому, если их нельзя использовать для конкретного случая, то они могут быть проигнорированы. Данные рекомендации никогда не будут идеально подходить для любых ситуаций, однако, всё же просим вас постараться придерживаться их "по максимуму", так как на основании ваших шаблонов другие участники могут создавать и корректировать свои наработки.
Категории[]
Существует достаточно много категорий для шаблонов. Добавляйте шаблон в ту категорию, которая наиболее тесно с ним связана.
Документация[]
Шаблоны должны обязательно иметь документацию на русском языке. Описывайте шаблоны, используя шаблон {{Документация}}.
Все нестандартные параметры шаблонов (см. #Стандартные параметры) должны быть задокументированы.
Функциональные возможности[]
Общее[]
Одиночные шаблоны, выполняющие множество простых функций, предпочтительнее множеству шаблонов, выполняющих всего одну функцию. В подобных шаблонах постарайтесь предусмотреть различные варианты параметров, которые только возможны, например, делайте так, чтобы значения параметров были не чувствительны к регистру.
Необходимо использовать именованные параметры везде, где это возможно. Избегайте не именованных параметров, за исключением обработки параметров по-умолчанию, что поможет остальным быстро научиться пользоваться такими шаблонами.
Синтаксис HTML[]
Как в шаблонах, так и везде на вики, необходимо использовать синтаксис XHTML 1.0 Transitional. Избегайте случаев использования в шаблонах параметра id языка HTML, так как шаблоны могут использоваться во множестве различных страниц.
Ifexist[]
Функция парсера {{#ifexist}} должна использоваться по возможности как можно реже.
Выполнение циклов[]
Циклы очень сложно реализовать в полном объёме в шаблонах для MediaWiki без специализированных дополнений, которых WoWWiki не имеет.
Стандартные параметры[]
Необходимо придерживаться стандартных названий при использовании наиболее часто применяемых параметров
- {{{doc}}}
- В шаблонах, которые осуществляют автоматическую подстановку категорий для страниц, используйте следующий синтаксис, чтобы избежать добавления в категорию страницы с самим шаблоном или любой страницы, описывающий этот шаблон:
{{{doc|[[Категория:<автоматически подставляемая категория>]]}}}
- Это позволит пользователям шаблона указывать пустой параметр для параметра "doc", если им необходимо избежать автоматического добавления категории для страницы, на которой используется этот шаблон.
- В шаблонах, которые осуществляют автоматическую подстановку категорий для страниц, используйте следующий синтаксис, чтобы избежать добавления в категорию страницы с самим шаблоном или любой страницы, описывающий этот шаблон: