Док

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

[обновить]

Использование

Создайте подстраницу шаблона с названием док, поставьте {{Док/Начало}} в начало документации и {{Док/Конец}} в её конец. Перейдите на страницу шаблона и на новой строке после кода шаблона поставьте <noinclude>{{/Док}}</noinclude>. Подстраницы /док будут автоматически добавляться в Категория:Документационные шаблоны.

Дополнительные параметры

clear

Если на странице с шаблоном есть плавающий контент, но вы не хотите, чтобы он закрывал документацию, замените строку {{Док/Начало}} на странице документации строкой {{Док/Начало|clear}}.

Это также можно применять в шаблонах, не использующих <includeonly>, так как в таком случае между шаблоном и документацией будет увеличено расстояние.

нетдок=1

Если у шаблона, которым вы не знаете, как пользоваться, нет документации, замените строку {{Док/Начало}} на странице документации строкой {{Док/Начало|нетдок=1}} (а если нужно также использование параметра clear, строкой {{Док/Начало|clear|нетдок=1}}).

Фон документации станет красным, чтобы увеличить её заметность, и страница будет добавлена в Категория:Шаблоны без документации.

плохдок=1

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

Фон документации станет жёлтым, чтобы увеличить её заметность, и страница будет добавлена в Категория:Шаблоны с плохой документацией.

Если и параметр нетдок, и параметр плохдок заданы, плохдок будет проигнорирован.